<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<head>
  <title>Kisa &#8212 live! spell checker: User Manual</title>
  <meta name="AUTHOR" content="Pete Black">
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <link rel="stylesheet" type="text/css" href="kisa.css">
  <link href="tabs.css" rel="stylesheet" type="text/css">
  <link href='kisa.ico' rel='shortcut icon' type='x-icon'/>
  <link href='kisa16.png' rel='icon' type='image/png'/>
</head>

<body>
  <h1>
    <img src="kisa32.png" alt="kisa logo" border="0">Kisa User Manual 0.63
  </h1>

<div align="center"><p><a href="mailto:theblackpeter@gmail.com?subject=Something%20about%20the%20great%20application%20Kisa">Pete Black</a></p></div><br>

<br>
<br>

<h2>Introduction</h2>
<p>Kisa provides spell checking as you type under <a href="http://en.wikipedia.org/wiki/X11">X11</a> desktops (such as <a href="http://en.wikipedia.org/wiki/KDE">KDE</a>) and displays the result in a small window on the Desktop (see figure 1). You can type anywhere, in any window and Kisa will spell check the word for you. Kisa uses <a href="http://en.wikipedia.org/wiki/GNU_Aspell">GNU Aspell</a> as a back-end, so it's relatively easy to manage and install more dictionaries when needed.</p>

<div class="image" align="center">
  <img src="kisa_widget.png" alt="Kisa main widget window" border="0"><br>
  <small>Figure 1. Kisa's main widget window</small>
</div>

<p>By connecting to the current X server running your Desktop, Kisa subscribes for event notifications from windows that it thinks interesting. Kisa uses standard <a href="http://en.wikipedia.org/wiki/X11">X11</a> event subscriptions to handle these event notifications.</p>

<p>For example, whenever there is a <em>keypress event</em> in a window, Kisa will be notified if subscribing for keypress events from that window. There is no logging or screen capturing performed and Kisa adheres to standard <a href="http://en.wikipedia.org/wiki/X11">X11</a> security principles. However, remember that <u>anything</u> you type can potentially be displayed. So when typing a password it may be shown in clear text.</p>


<dl class="note" compact><dt><b>Note:</b></dt>
  <dd>That Kisa is not a
    <ul compact="true">
      <li>thesaurus (at least not yet)</li>
      <li>word completer, type first 3 characters and get the full word</li>
      <li><a href="http://en.wikipedia.org/wiki/Keylogger">keylogger</a></li>
      <li>way to save the world, unfortunately</li>
    </ul>
  </dd>
</dl>
<br>


<h3>License</h3>
<p><a href="http://kisa.googlecode.com/files/COPYING">Gnu General Public License (GPL) version 2.</a></p>

<br>


<h3>Runtime Requirements</h3>
<ul compact="true">
   <li><a href="http://en.wikipedia.org/wiki/X11">X11</a> (tested under X.org 7.2)</li>
   <li><a href="http://en.wikipedia.org/wiki/GNU_Aspell">Aspell</a> spell checker runtime library
    (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: libaspell15)</li>
   <li><a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a> core GUI runtime library 4.3.2 or later
    (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: libqt4-gui)</li>
</ul>

<br>


<h3>Compile Requirements</h3>
<ul compact="true">
   <li><a href="http://en.wikipedia.org/wiki/X11">X11</a> client-side library development headers (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: libx11-dev)</li>
   <li><a href="http://en.wikipedia.org/wiki/GNU_Aspell">Aspell</a> development libraries (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: libaspell-dev)</li>
   <li><a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a> development files 4.3.2 or later (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: libqt4-dev)</li>
   <li><a href="http://en.wikipedia.org/wiki/GNU_C%2B%2B">GNU C++</a> compiler (<a href="http://en.wikipedia.org/wiki/Debian">Debian</a> package: g++)</li>
</ul>
<br>

<hr>
<br>


<h2>Installation</h2>


<h3>Package Installation</h3>
<h4><a href="http://en.wikipedia.org/wiki/Gentoo">Gentoo</a></h4>
<p>Download and extract <code><a href="http://kisa.googlecode.com/files/kisa-0.63.ebuild.tar.bz2">kisa-0.63.ebuild.tar.bz2</a></code> under your portage overlay directory (usually <code>/usr/local/portage</code>), <code>digest</code> the <em>ebuild</em> and <code>emerge</code> like usual. Something like this would do it:</p>
<pre class="fragment">
  cd /usr/local/portage
  wget "http://kisa.googlecode.com/files/kisa-0.63.ebuild.tar.bz2"
  tar -xvjf kisa-0.63.ebuild.tar.bz2
  rm kisa-0.63.ebuild.tar.bz2
  ebuild kde-misc/kisa/kisa-0.63.ebuild digest
  emerge kisa
</pre>

<p>Translations will be installed if available for languages specified by the <code>LINGUAS</code> variable in <code>/etc/make.conf</code>.</p>

<h4>All other Distributions</h4>
<p>Check your package manager documentation for details on how to install custom packages.</p>

<br>


<h3>Installation from Source</h3>
<p>Unpack <code>kisa-0.63.tar.bz2</code> and from that folder do (make sure you use the <a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a> 4 version of <code>qmake</code>):</p>
<pre class="fragment">
  qmake<sup>1, 2</sup>
  make
  sudo make install<sup>3</sup>
</pre>

<br>


<h3>Uninstallation from Source</h3>
<p>From the source folder do:</p>
<pre class="fragment">
  sudo make uninstall<sup>3</sup>
</pre>

<br>

<p>(1) To install available translations files pass the desired language to qmake in the <code>LINGUAS</code> variable:</p>
<pre class="fragment">
  qmake LINGUAS="sv"
</pre>

<p>(2) For debug support do: (enable full debug output by setting <code>FULL_DEBUG</code> flag)</p>
<pre class="fragment">
  qmake -config debug "DEFINES += FULL_DEBUG"
</pre>

<p>(3) <strong>Note:</strong> <code>sudo</code> might not be available to on your system. This step is only necessary for installation or uninstallation, but requires root privileges. You can run the application by executing the binary <code>kisa</code> in the resulting bin folder.</p>
<br>

<hr>
<br>
<br>


<h2>Using Kisa</h2>
<h3>Startup</h3>
<p>Start Kisa via your Desktop's application menu or by the command <code>kisa</code> form a terminal or command execution prompt after installation. Figure 2 shows <a href="http://en.wikipedia.org/wiki/KDE">KDE's</a> K Menu, where Kisa is located under the utilities section.</p>
<div class="image" align="center">
  <img src="kisa_start_menu.png" alt="Kisa K Menu startup" border="0"><br>
  <small>Figure 2. Starting Kisa using <a href="http://en.wikipedia.org/wiki/KDE">KDE's</a> K Menu</small>
</div>
<br>


<h3>Command-line Options</h3>
<p>Table 1. shows the available command-line options recognized by Kisa. Use them only when there is a need to override the default settings.</p>
<table align="center" summary="Kisa command-line options" cellpadding="10">
  <tbody>
    <tr>
      <td>-help</td>
      <td>Shows this help</td>
    </tr>
    <tr>
      <td>-display &#060;display&#062;</td>
      <td>The display on the X server to use</td>
    </tr>
    <tr>
      <td>-language &#060;language&#062;</td>
      <td>The default application language</td>
    </tr>
    <tr>
      <td>-icons &#060;path&#062;</td>
      <td>Where to look for action icons</td>
    </tr>
    <tr>
      <td>-flags &#060;path&#062;</td>
      <td>Where to look for country flag icons</td>
    </tr>
    <tr>
      <td>-dict-dir &#060;path&#062;</td>
      <td>Main word list location</td>
    </tr>
    <tr>
      <td>-aspell-prefix &#060;path&#062;</td>
      <td>Aspell prefix directory</td>
    </tr>
    <tr>
      <td>-extra-dicts &#060;list&#062;</td>
      <td>List of extra dictionaries to use</td>
    </tr>
  </tbody>
</table>
<div align="center"><small>Table 1. Available Kisa command-line options</small></div>
<br>


<h5>Example:</h5>
<pre class="fragment">
  kisa -language sv -icons ~/myTheme -flags /usr/share/locale/l10n
</pre>
<p>This will use Swedish as application language, the icons from the theme located under <code>"~/myTheme"</code> and the flag icons from <code>"/usr/share/locale/l10n"</code>
</p>

<dl class="note" compact><dt><b>Note:</b></dt>
  <dd><a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a> also provides a large set of command-line options to change default settings. These are covered <a href="http://doc.trolltech.com/qapplication.html#QApplication">here</a>.
  </dd>
</dl>
<br>

<h3>Main window</h3>
<p>The main window will appear at startup displaying a text field and a tool button. The tool button shows the current selected dictionary, either via a country flag icon or by language code. The initial dictionary will be set to that of the current keyboard layout at startup. If the dictionary is not available Kisa may fail to start. The <code>-language &#060;language&#062;</code> flag can be used to select a different application language</p>


<h4>Tool button</h4>
<p>A small arrow will appear in the bottom right corner of the tool button whenever there is is more then one dictionary available for the session. Add more dictionaries using the Settings, which are accessible through the System Tray icon menu described below.</p>

<p>Left-clicking on the tool button will select the next dictionary by cycling through the session list of dictionaries. Press and hold down the tool button to see the full list or to clear it as displayed in figure 3.</p>

<div class="image" align="center">
  <img src="kisa_dictionary_popup.png" alt="Kisa dictionary popup" border="0"><br>
  <small>Figure 3. Kisa's tool button showing the dictionary pop-up list</small>
</div>
<br>


<h4>Suggestions Pop-up</h4>
<p>Kisa will automatically subscribe for event notification from other windows on the Desktop at startup. Typing letter characters in any other window (that Kisa recives event notifications from) will also make them appear in Kisa's text field.</p>

<p>Whenever a punctuation or a whitespace, such as "." or "space", is entered a spellcheck will be triggered for the current text in the text field (the word). Any non-letter or unrecognized character, such as a digit or "ctrl", will clear the text field.</p>

<p>If the given word is not in the word list for that dictionary a drop-down box will show a list off suggestions. Selecting any of the words from the suggestion list will replace the misspelled word with that in the text field.</p>

<div class="image" align="center">
  <img src="kisa_suggestion_popup.png" alt="Kisa suggestion popup" border="0"><br>
  <small>Figure 4. Kisa's main widget window and suggestion list pop-up</small>
</div>
<br>

<dl class="tip" compact><dt><b>Tip:</b></dt>
  <dd>Single-clicking on a misspelled word in the text field will execute the custom command. See the section about the custom command below for more information.</dd>
</dl>

<dl class="note" compact><dt><b>Note:</b></dt>
  <dd>Remember that <u>anything</u> you type can potentially be displayed. So when typing a password it may be shown in clear text.</dd>
</dl>
<br>

<h3>Context menu</h3>
<p>Right-clicking on the text field will bring up the context menu, shown in figure 5. A variety of options in addition to the default editing functions are available here, which are explained in table 2.</p>

<div class="image" align="center">
  <img src="kisa_context_menu.png" alt="Figure 5. Kisa's custom context menu" border="0"><br>
  Kisa's custom context menu
</div>
<br>

<table align="center" summary="Kisa Context Menu Options" cellpadding="10" width="80%">
  <tbody>
    <tr>
      <td><img src="list-add.png" border="0"> Add "word" to the personal word list</td>
      <td><a href="http://en.wikipedia.org/wiki/GNU_Aspell">Aspell's</a> personal word lists are usually stored under the home directory in <code>.aspell.&#060;language_code&#062;.pws</code></td>
    </tr>
    <tr>
      <td><img src="trash-empty.png" border="0"> Ignore "word"</td>
      <td>Ignores the word for the session by adding it to the session word list</td>
    </tr>
    <tr>
      <td><img src="preferences-desktop-keyboard.png" border="0"> Set left-to-right/right-to-left</td>
      <td>Overides the automatic settings and toggles the text input direction</td>
    </tr>
    <tr>
      <td><img src="google.png" border="0" width="16" height="16"> Google Define<br>
      (custom command)</td>
      <td>Runs the custom command, which by default takes you to <a href="http://www.google.com/help/features.html#definitions">Goole Define</a> for the given word</td>
    </tr>
  </tbody>
</table>
<div align="center"><small>Table 2. The additional context menu commands</small></div>
<br>

<hr>
<br>


<h3>System Tray Icon Menu</h3>
<p>An icon will also appear in the System Tray displaying the current state of the application. If the icons is grayed-out or shaded it means that Kisa is not running and any event subscription is disabled as illustraded by figure 6.</p>

<div class="image" align="center">
  <img src="systray_disabled.png" alt="Kisa systray disabled" border="0"><br>
  <small>Figure 6. The Kisa System Tray icon when disabled</small>
</div>
<br>

<p>Left-clicking on the icon will hide and disabled Kisa. Useful for when you want to quickly stop the application without actually closing it. In this state all event notifications will be disabled.</p>

<p>Right-clicking on the System Tray icon will bring up the Kisa System Tray icon menu as shown by figure 7. Table 3 explains the different options in greater detail.</p>


<div class="image" align="center">
  <img src="systray_menu.png" alt="Kisa System Tray menu" border="0"><br>
  <small>Figure 7. The Kisa System Tray menu</small>
</div>
<br>

<table align="center" summary="Kisa System Tray Menu Options" cellpadding="10" width="80%">
  <tbody>
    <tr>
      <td><img src="system.png" border="0"> <u>R</u>un/ <img src="process-stop.png" border="0"> <u>S</u>top</td>
      <td>Run or Stops the application depending on its current state.<br>
          If stopped the main widget window will be disabled as shown by figure 9.</td>
    </tr>
    <tr>
      <td><img src="kwin.png" border="0"> R<u>e</u>store</td>
      <td>Restore the main widget window if it has been minimized or hidden</td>
    </tr>
    <tr>
      <td><img src="configure.png" border="0"> Se<u>t</u>tings</td>
      <td>Access the Kisa Settings window</td>
    </tr>
    <tr>
      <td><img src="help-about.png" border="0"> <u>H</u>elp</td>
      <td>Get here! Opens the on-line manual</td>
    </tr>
    <tr>
      <td><img src="kisa16.png" border="0"> <u>A</u>bout Kisa</td>
      <td>Shows information about the current version (see figure 8)</td>
    </tr>
    <tr>
      <td><img src="qt-logo.png" border="0" width="16" height="16"> A<u>b</u>out <a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a></td>
      <td>Shows information about the current <a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt</a> version (see figure 9)</td>
    </tr>
    <tr>
      <td><img src="application-exit.png" border="0"> <u>Q</u>uit</td>
      <td>Exits the application</td>
    </tr>
  </tbody>
</table>
<div align="center"><small>Table 3. Available Kisa System Tray menu options</small></div>

<dl class="note" compact><dt><b>Note:</b></dt>
  <dd>The actual icons depend on the current icon theme of the Desktop or the user supplied at startup.</dd>
</dl>
<br>

<div class="image" align="center">
  <img src="kisa_about.png" alt="About Kisa" border="0"><br>
  <small>Figure 8. "About Kisa" shows the the current application information</small>
</div>
<br>

<br>

<div class="image" align="center">
  <img src="kisa_about_qt.png" alt="About Qt" border="0"><br>
  <small>Figure 9. "About Qt" shows the current Qt information</small>
</div>
<br>

<br>

<div class="image" align="center">
  <img src="kisa_disabled.png" alt="Kisa disabled" border="0"><br>
  <small>Figure 10. The Kisa main widget window when disabled</small>
</div>
<br>

<hr>
<br>


<h2>Sessions Management</h2>
<p>Kisa provides full support for session saving and restoring. Any running session of Kisa will be saved and restarted automatically by your session manager.</p>
<br>

<hr>
<br>


<h2>Settings and Configuration</h2>

<p>The Settings window (see figure 11), is accessed via the System Tray menu, that is, by right-clicking on the Kisa icon in the System Tray. The settings are stored in the file <code>".config/Kisa/Kisa.conf"</code> under your home folder. This is just a regular text file (or INI file) and can be edited in your favorite text editor. To create a new one, remove the old, change any setting and select "OK".</p>

<h3>General</h3>
<p>Alter general application behavior and select dictionaries here.</p>

<div class="image" align="center">
  <img src="general.png" alt="Kisa Settings Window" border="0"><br>
  <small>Figure 11. The Kisa Settings Window showing the general application tab</small>
</div>
<br>


<h4>Spell Checker</h4>
<h5>Client</h5>
<p>Only <a href="http://en.wikipedia.org/wiki/GNU_Aspell">Aspell</a> is implemented at the moment, <a href="http://en.wikipedia.org/wiki/KDE">KDE</a> and GNOME system integration may be made available at a later stage.</p>

<h5>Dictionary</h5>
<p>Select a dictionary from the available here, as figure 12 illustrates. This list is updated at startup, according to what dictionaries are available on the system.</p>

<div class="image" align="center">
  <img src="dictionaries.png" alt="Dictionaries" border="0"><br>
  <small>Figure 12. The available dictionaries installed on the system</small>
</div>
<br>


<h5>Encoding</h5>
<p>Only utf-8 is implemented at the moment, other encodings may follow.</p>

<br>


<h4>Behavior</h4>

<h5>Stay on top</h5>
<p>If checked, Kisa will always stay above other windows on the Desktop.</p>

<div class="image" align="center">
  <img src="stay_on_top.png" alt="Stay-on-top option" border="0"><br>
  <small>Figure 13. The "stay on top" option</small>
</div>
<br>


<h5>Change dictionary on keyboard layout change</h5>
<p>Kisa will change the current dictionary every time the keyboard layout is changed so to match the new language.</p>

<div class="image" align="center">
  <img src="change_on_keyboard_layout.png" alt="Update on keyboard layout change option" border="0"><br>
  <small>Figure 14. The "change dictionary on keyboard layout change" option</small>
</div>
<br>

<h5>Copy suggestion to clipboard</h5>
<p>If checked, whenever a word is selected from the suggestions popop, it's also added to the Clipboard. There is then easy access to the word by pasting it in any application.</p>

<div class="image" align="center">
  <img src="copy_to_clipboard.png" alt="Copy to clipboard option" border="0"><br>
  <small>Figure 15. The "copy suggestion to clipboard" option</small>
</div>
<br>


<h5>Replace misspelled word in client window</h5>
<p><strong style="color : #FF0000;">WARNING!</strong> Use with care.</p>

<p>Kisa will try to remove the recent misspelled word from the client application (the window from where the event was received) and replace it with the selected word from the pop-up.</p>

<p>This may not always work, as Kisa really has no idea what's going on in any other window. Instead the new word is sent back to the window where the event occurred and if the cursor position has changed, for instance, unexpected behavior may occur. That is, this feature does not always do what you think it will do. Consider yourself warned.</p>

<div class="image" align="center">
  <img src="replace_in_client.png" alt="Replace in client option" border="0"><br>
  <small>Figure 16. The "replace misspelled word in client window" option</small>
</div>
<br>


<h5>Treat hyphen as punctuation</h5>
<p>If checked, then hyphens, "-", will be treated as punctuations. That is, spellchecks will be issued on the conjoined words separately.</p>

<p>Using this option will only let you see one word at the time though.</p>

<div class="image" align="center">
  <img src="hyphen_as_punctuation.png" alt="Hyphen as punctuation option" border="0"><br>
  <small>Figure 17. The "treat hyphen as punctuation" option</small>
</div>
<br>



<h3>Appearance</h3>
<p>Change the <em>look and feel</em> of the program here.</p>

<div class="image" align="center">
  <img src="appearance.png" alt="Appearance settings" border="0"><br>
  <small>Figure 18. Kisa appearance settings</small>
</div>
<br>

<h4>Font</h4>
<p>Select the desired font for the main window. Font family, style (<strong>bold</strong> or <em>italic</em>) and font size may be set. Any installed font that is known to the system is available.</p>


<h5>Font Type</h5>
<p>Selected font to use in the main window. Set to use <strong>bold</strong>, <strong>italic</strong>.</p>

<div class="image" align="center">
  <img src="font_combo_box.png" alt="Font type option" border="0"><br>
  <small>Figure 19. Font type selection</small>
</div>
<br>


<h5>Font Size</h5>
<p>Size of the font to use in the main window.</p>

<div class="image" align="center">
  <img src="kisa_big_font.png" alt="Unusual font" border="0"><br>
  <small>Figure 20. Kisa with an unusual font selection</small>
</div>
<br>


<h4>Dictionary Information</h4>
<h5>Show dictionary information</h5>
<p>If checked, Kisa will display the current dictionary in use. If not, then the main window will be without a tool button, as seen in figure 22.</p>

<div class="image" align="center">
  <img src="show_button.png" alt="Show button option" border="0"><br>
  <small>Figure 21. The "show dictionary info button" option</small>
</div>
<br>

<div class="image" align="center">
  <img src="kisa_widget_no_button.png" alt="No button" border="0"><br>
  <small>Figure 22. The main window with no language button</small>
</div>
<br>


<h5>Show country flag representing the dictionary language</h5>
<p>If checked, Kisa will display a small flag of the country representing the language of the dictionary. If not, then the language code will be displayed, which figure 23 illustrates.</p>

<p>This might not always be accurate as there are single languages that are spoken in several countries. <a href="http://en.wikipedia.org/wiki/Qt_(toolkit)">Qt's</a> locale system will be used in order to make a best match for the country given the language. For instance, English with language code "en" will be matched to "en_US", that is American English.</p>

<div class="image" align="center">
  <img src="show_flag.png" alt="Show flag option" border="0"><br>
  <small>Figure 23. Show country flag representing the dictionary language</small>
</div>
<br>

<div class="image" align="center">
  <img src="kisa_widget_no_flag.png" alt="Show no flag" border="0"><br>
  <small>Figure 24. The main window with no country flag icon</small>
</div>
<br>


<h4>Notifications</h4>
<h5>Show pop-up</h5>
<p>If checked, a pop-up will be shown in the main window containing suggestions whenever a word is not found in the dictionary.</p>

<h5>Pop-up duration</h5>
<p>Sets the suggestion pop-up duration in s. If set 0 the pop-up will stay visible until the next click.</p>

<div class="image" align="center">
  <img src="show_popup.png" alt="Show pop-up option" border="0"><br>
  <small>Figure 25. The "show pop-up" and pop-up duration options</small>
</div>
<br>


<h4>Show System Tray pop-up</h4>
<p>If checked, a pop-up will be shown in the System Tray whenever a word is not found in the word list. An example of that is shown in figure 26.</p>

<div class="image" align="center">
  <img src="systray_popup.png" alt="Kisa System Tray pop-up" border="0"><br>
  <small>Figure 26. The Kisa System Tray pop-up</small>
</div>
<br>


<h5>System Tray pop-up duration visibility</h5>
<p>Specifies the duration for how long the System Tray pop-up stays visible in s.</p>

<div class="image" align="center">
  <img src="show_systray_popup.png" alt="Show pop-up option" border="0"><br>
  <small>Figure 27. The Kisa System Tray pop-up and duration options</small>
</div>
<br>


<h3>Extras</h3>
<p>Additional setting are located here, where you can tune and customize Kisa to meet all your needs and desires.</p>

<p>Well... maybe not all, but almost all?</p>

<div class="image" align="center">
  <img src="extras.png" alt="Extras" border="0"><br>
  <small>Figure 28. Kisa extras settings</small>
</div>
<br>

<h4>Window Ignore List</h4>
<p>The window ignore list functions as a black list for desktop windows that we don't want any nofications from. Kisa will ignore any window containing any of these words when subscribing for notification.</p>

<p>For example, a window with the name "Konqueror main - toolbar" will be ignored whenever the word "toolbar" is in the list.</p>

<p>Use the text field and buttons next to it to add and remove items from the list, as shown in figure 29.</p>

<p>There is no need to add the application name "Kisa", as that is managed internally.</p>

<div class="image" align="center">
  <img src="ignore_list.png" alt="Ignore list" border="0"><br>
  <small>Figure 29. The ignore list settings</small>
</div>
<br>

<h4>Custom Command</h4>
<p>Holds a custom command that can be executed from the context menu (by right-clicking on the text field) or by clicking on a misspelled word. The command can be any command that you can run on the system or a protocol like a Web URL.</p>

<p>When using a system command, make sure to specify the full path of the command if its directory is not in the $PATH variable.</p>

<p>When specifying a protocol, like http, the system default application will be used specified in the Desktop's settings.</p>

<p>Possible variable that you pass to your command are given by table 4.</p>
<table align="center" summary="Kisa System Tray Menu Options" cellpadding="10">
  <tbody>
    <tr>
      <td><code>$LANG</code></td>
      <td>the current language</td>
    </tr>
    <tr>
      <td><code>$WORD</code></td>
      <td>the current word in the text field</td>
    </tr>
  </tbody>
</table>
<div align="center"><small>Table 4. Possible variables that can be passed to the custom command</small></div>
<br>

<h5>Command Name</h5>
<p>Select the command name by entering it in the text field. It will then appear in the context menu.</p>

<h5>Icon</h5>
<p>Clicking on the icon button will bring up a file selection dialog (see figure 30). Select the image icon that will be shown in the context menu for the custom command from there.</p>

<div class="image" align="center">
  <img src="icon_file_dialog.png" alt="Custom command icon selection" border="0"><br>
  <small>Figure 30. The custom command icon selection file dialog</small>
</div>
<br>

<hr>
<br>


<h2>Disclaimer</h2>
<p>
THIS INFORMATION AND/OR SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS INFORMATION AND/OR SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</p>
<br>

<!-- kisa footer start -->
  <hr>
  <table width="100%" cellspacing="0" border="0" cellpadding="0" align="left" frame="void" summary="">
    <tbody valign="top">
      <tr>
        <td align="left">
          <small>
            <a href="http://kisa.googlecode.com">
              <img src="kisa16.png" alt="kisa logo" align="left" border="0">Kisa &#8212; live! spell checker
            </a>
          </small>
        </td>
        <td align="right">
          <small>
            Last updated on Moday February 23, 2009<br>
            Copyright &#169; 2009 <a href="mailto:theblackpeter@gmail.com?subject=Something%20about%20the%20great%20application%20Kisa">Pete Black</a>
          </small>
        </td>
      </tr>
    </tbody>
  </table>
</body>
</html
